Crate dioxus_desktop

Dioxus Desktop Renderer

Render the Dioxus VirtualDom using the platform’s native WebView implementation.

Desktop

One of Dioxus’ killer features is the ability to quickly build a native desktop app that looks and feels the same across platforms. Apps built with Dioxus are typically <5mb in size and use existing system resources, so they won’t hog extreme amounts of RAM or memory.

Dioxus Desktop is built off Tauri. Right now there aren’t any Dioxus abstractions over keyboard shortcuts, menubar, handling, etc, so you’ll want to leverage Tauri - mostly Wry and Tao) directly. The next major release of Dioxus-Desktop will include components and hooks for notifications, global shortcuts, menubar, etc.

Getting Set up

Getting Set up with Dioxus-Desktop is quite easy. Make sure you have Rust and Cargo installed, and then create a new project:

$ cargo new --bin demo
$ cd app

Add Dioxus with the desktop feature:

$ cargo add dioxus --features desktop

Edit your main.rs:

// main.rs
use dioxus::prelude::*;

fn main() {
    dioxus::desktop::launch(app);
}

fn app(cx: Scope) -> Element {
    cx.render(rsx!{
        div {
            "hello world!"
        }
    })
}

To configure the webview, menubar, and other important desktop-specific features, checkout out some of the launch configuration in the API reference.

Future Steps

Make sure to read the Dioxus Guide if you already haven’t!

Re-exports

pub use wry;

Modules

cfg

escape

events

Convert a serialized event to an event Trigger

tao

Re-exported Tao APIs

Structs

DesktopController

Enums

UserWindowEvent

Functions

launch

Launch the WebView and run the event loop.

launch_cfg

Launch the WebView and run the event loop, with configuration.

launch_with_props

Launch the WebView and run the event loop, with configuration and root props.